<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Functions</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__sysclk__clk__hf__funcs.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Functions<div class="ingroups"><a class="el" href="group__group__sysclk.html">SysClk       (System Clock)</a> &raquo; <a class="el" href="group__group__sysclk__clk__hf.html">High-Frequency Clocks</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaf3041fc8333478cc7c8d869d2a535d71"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__hf__funcs.html#gaf3041fc8333478cc7c8d869d2a535d71">Cy_SysClk_ClkHfEnable</a> (uint32_t clkHf)</td></tr>
<tr class="memdesc:gaf3041fc8333478cc7c8d869d2a535d71"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enables the selected clkHf.  <a href="#gaf3041fc8333478cc7c8d869d2a535d71">More...</a><br /></td></tr>
<tr class="separator:gaf3041fc8333478cc7c8d869d2a535d71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga47252e1861afb4664f43c2e0a5e38055"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__hf__funcs.html#ga47252e1861afb4664f43c2e0a5e38055">Cy_SysClk_ClkHfIsEnabled</a> (uint32_t clkHf)</td></tr>
<tr class="memdesc:ga47252e1861afb4664f43c2e0a5e38055"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports the Enabled/Disabled status of clkHf.  <a href="#ga47252e1861afb4664f43c2e0a5e38055">More...</a><br /></td></tr>
<tr class="separator:ga47252e1861afb4664f43c2e0a5e38055"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaa60ae6f69c8a594756a219ac8891358"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__hf__funcs.html#gaaa60ae6f69c8a594756a219ac8891358">Cy_SysClk_ClkHfDisable</a> (uint32_t clkHf)</td></tr>
<tr class="memdesc:gaaa60ae6f69c8a594756a219ac8891358"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disables the selected clkHf.  <a href="#gaaa60ae6f69c8a594756a219ac8891358">More...</a><br /></td></tr>
<tr class="separator:gaaa60ae6f69c8a594756a219ac8891358"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2d39c7e5111f9ba0738f032a98b4593e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__hf__funcs.html#ga2d39c7e5111f9ba0738f032a98b4593e">Cy_SysClk_ClkHfSetSource</a> (uint32_t clkHf, <a class="el" href="group__group__sysclk__clk__hf__enums.html#gabac2d6b9124a00860dcd781a922788d6">cy_en_clkhf_in_sources_t</a> source)</td></tr>
<tr class="memdesc:ga2d39c7e5111f9ba0738f032a98b4593e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Selects the source of the selected clkHf.  <a href="#ga2d39c7e5111f9ba0738f032a98b4593e">More...</a><br /></td></tr>
<tr class="separator:ga2d39c7e5111f9ba0738f032a98b4593e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga464acde9f381963929fae73189e80f5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__sysclk__clk__hf__enums.html#gabac2d6b9124a00860dcd781a922788d6">cy_en_clkhf_in_sources_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__hf__funcs.html#ga464acde9f381963929fae73189e80f5c">Cy_SysClk_ClkHfGetSource</a> (uint32_t clkHf)</td></tr>
<tr class="memdesc:ga464acde9f381963929fae73189e80f5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports the source of the selected clkHf.  <a href="#ga464acde9f381963929fae73189e80f5c">More...</a><br /></td></tr>
<tr class="separator:ga464acde9f381963929fae73189e80f5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga66c6e94768403ab318f2aa321b4c1e50"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__hf__funcs.html#ga66c6e94768403ab318f2aa321b4c1e50">Cy_SysClk_ClkHfSetDivider</a> (uint32_t clkHf, <a class="el" href="group__group__sysclk__clk__hf__enums.html#gadfbf0caf87af7cd757648124fb17d1d4">cy_en_clkhf_dividers_t</a> divider)</td></tr>
<tr class="memdesc:ga66c6e94768403ab318f2aa321b4c1e50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the pre-divider for a clkHf.  <a href="#ga66c6e94768403ab318f2aa321b4c1e50">More...</a><br /></td></tr>
<tr class="separator:ga66c6e94768403ab318f2aa321b4c1e50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4d8e4a7091e32319bc2c79f3e2809912"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__sysclk__clk__hf__enums.html#gadfbf0caf87af7cd757648124fb17d1d4">cy_en_clkhf_dividers_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__hf__funcs.html#ga4d8e4a7091e32319bc2c79f3e2809912">Cy_SysClk_ClkHfGetDivider</a> (uint32_t clkHf)</td></tr>
<tr class="memdesc:ga4d8e4a7091e32319bc2c79f3e2809912"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports the pre-divider value for a clkHf.  <a href="#ga4d8e4a7091e32319bc2c79f3e2809912">More...</a><br /></td></tr>
<tr class="separator:ga4d8e4a7091e32319bc2c79f3e2809912"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafa8c21271b8cb1b1fd9f7fb489a8d2b3"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__hf__funcs.html#gafa8c21271b8cb1b1fd9f7fb489a8d2b3">Cy_SysClk_ClkHfGetFrequency</a> (uint32_t clkHf)</td></tr>
<tr class="memdesc:gafa8c21271b8cb1b1fd9f7fb489a8d2b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports the frequency of the selected clkHf.  <a href="#gafa8c21271b8cb1b1fd9f7fb489a8d2b3">More...</a><br /></td></tr>
<tr class="separator:gafa8c21271b8cb1b1fd9f7fb489a8d2b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gace8a5255f8579c17f4062dccb3ff3694"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__hf__funcs.html#gace8a5255f8579c17f4062dccb3ff3694">Cy_SysClk_ClkHfDirectSel</a> (uint32_t clkHf, bool enable)</td></tr>
<tr class="memdesc:gace8a5255f8579c17f4062dccb3ff3694"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable/Disable the direct source selection as IMO for CLK_HF[[n]].  <a href="#gace8a5255f8579c17f4062dccb3ff3694">More...</a><br /></td></tr>
<tr class="separator:gace8a5255f8579c17f4062dccb3ff3694"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga58bb033cfac5881d026e32643ed6c6b7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__hf__funcs.html#ga58bb033cfac5881d026e32643ed6c6b7">Cy_SysClk_IsClkHfDirectSelEnabled</a> (uint32_t clkHf)</td></tr>
<tr class="memdesc:ga58bb033cfac5881d026e32643ed6c6b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks if direct source selection as IMO for CLK_HF[[n]] is enabled/disabled.  <a href="#ga58bb033cfac5881d026e32643ed6c6b7">More...</a><br /></td></tr>
<tr class="separator:ga58bb033cfac5881d026e32643ed6c6b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga46accf22663e93afbcd92d41fe47f613"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__hf__funcs.html#ga46accf22663e93afbcd92d41fe47f613">Cy_SysClk_ClkHfGetMaskOnPath</a> (<a class="el" href="group__group__sysclk__clk__hf__enums.html#gabac2d6b9124a00860dcd781a922788d6">cy_en_clkhf_in_sources_t</a> clkPath)</td></tr>
<tr class="memdesc:ga46accf22663e93afbcd92d41fe47f613"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get Mask value for the HF Clocks selected and enabled for clkPath as source e.g.  <a href="#ga46accf22663e93afbcd92d41fe47f613">More...</a><br /></td></tr>
<tr class="separator:ga46accf22663e93afbcd92d41fe47f613"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad7f4310594a4441d01ac1c46df0a1234"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__hf__funcs.html#gad7f4310594a4441d01ac1c46df0a1234">Cy_SysClk_ClkHfAllGetMask</a> (void)</td></tr>
<tr class="memdesc:gad7f4310594a4441d01ac1c46df0a1234"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get Mask value for the all HF Clocks e.g.  <a href="#gad7f4310594a4441d01ac1c46df0a1234">More...</a><br /></td></tr>
<tr class="separator:gad7f4310594a4441d01ac1c46df0a1234"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3b86beecfee7ea5361decab70bc7e4b3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__hf__funcs.html#ga3b86beecfee7ea5361decab70bc7e4b3">Cy_SysClk_ClkHfEnableDividerWithMask</a> (uint32_t clkHfMask, <a class="el" href="group__group__sysclk__clk__hf__enums.html#gadfbf0caf87af7cd757648124fb17d1d4">cy_en_clkhf_dividers_t</a> divider)</td></tr>
<tr class="memdesc:ga3b86beecfee7ea5361decab70bc7e4b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Divide all the enabled CLK_HF's with the divider value.  <a href="#ga3b86beecfee7ea5361decab70bc7e4b3">More...</a><br /></td></tr>
<tr class="separator:ga3b86beecfee7ea5361decab70bc7e4b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4053d66942358380e99583c0ef4d99a5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__sysclk__clk__hf__funcs.html#ga4053d66942358380e99583c0ef4d99a5">Cy_SysClk_ClkHfEnableDirectMuxWithMask</a> (uint32_t clkHfMask, bool enable)</td></tr>
<tr class="memdesc:ga4053d66942358380e99583c0ef4d99a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable/ Disable the clock path for the HF Clocks in clkHfMask in disable case ROOT path will be enabled in enable case ROOT path will be disabled.  <a href="#ga4053d66942358380e99583c0ef4d99a5">More...</a><br /></td></tr>
<tr class="separator:ga4053d66942358380e99583c0ef4d99a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gaf3041fc8333478cc7c8d869d2a535d71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf3041fc8333478cc7c8d869d2a535d71">&#9670;&nbsp;</a></span>Cy_SysClk_ClkHfEnable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a> Cy_SysClk_ClkHfEnable </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>clkHf</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enables the selected clkHf. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">clkHf</td><td>Selects which clkHf to enable.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a> CY_PRA_STATUS_* - For the PSoC 64 devices there are possible situations when function returns the PRA error status code <a class="el" href="group__group__pra__enums.html#ga60be13e12e82986f8c0d6c6a6d4f12c5">cy_en_pra_status_t</a> instead of <a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a>. This is because for PSoC 64 devices the function uses the PRA driver to change the protected registers. Refer to <a class="el" href="group__group__pra__enums.html#ga60be13e12e82986f8c0d6c6a6d4f12c5">cy_en_pra_status_t</a> for more details.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: ECO needs to source HFCLK2 through Path 2. The ECO is</span></div><div class="line"><span class="comment">                 configured through its function calls. */</span></div><div class="line"></div><div class="line"><span class="preprocessor">    #define CLKPATH2 (2UL)</span></div><div class="line"><span class="preprocessor">    #define HFCLK2 (2UL)</span></div><div class="line"></div><div class="line">    uint32_t clkPathMuxFreq = 0UL; <span class="comment">/* Variable to store the Clock Path Mux output frequency */</span></div><div class="line"></div><div class="line">    <span class="comment">/* Set the clock path 2 mux to be sourced from ECO */</span></div><div class="line">    <span class="keywordflow">if</span>(<a class="code" href="group__group__sysclk__returns.html#ggad6699a184e2e3c01433251b0981558f3a1563f761f963757b339ff05eb5a690ec">CY_SYSCLK_SUCCESS</a> == <a class="code" href="group__group__sysclk__path__src__funcs.html#ga517f603266062d0013947ea950ed5b60">Cy_SysClk_ClkPathSetSource</a>(CLKPATH2, <a class="code" href="group__group__sysclk__path__src__enums.html#gga8ddaf9023a02dee0d1f9a5629d6ccfe6a28f5ad80fd20d8459d40aa8b86d3a77e">CY_SYSCLK_CLKPATH_IN_ECO</a>))</div><div class="line">    {</div><div class="line">        clkPathMuxFreq = <a class="code" href="group__group__sysclk__path__src__funcs.html#ga1256c8a7290cecf2b9553a1df582e797">Cy_SysClk_ClkPathMuxGetFrequency</a>(CLKPATH2);</div><div class="line">        <span class="comment">/* Now clkPathMuxFreq contains the Clock Path Mux output frequency */</span></div><div class="line">    }</div><div class="line">    <span class="keywordflow">else</span></div><div class="line">    {</div><div class="line">        <span class="comment">/* Perform error handling */</span></div><div class="line">    }</div><div class="line"></div><div class="line">    <span class="comment">/* Set the HFCLK2 source to clock path 2 and enable HFCLK2 */</span></div><div class="line">    (void)<a class="code" href="group__group__sysclk__clk__hf__funcs.html#ga2d39c7e5111f9ba0738f032a98b4593e">Cy_SysClk_ClkHfSetSource</a>(HFCLK2, <a class="code" href="group__group__sysclk__clk__hf__enums.html#ggabac2d6b9124a00860dcd781a922788d6a7a35a9d5b37d1add71bd6f866953366e">CY_SYSCLK_CLKHF_IN_CLKPATH2</a>);</div><div class="line"></div><div class="line">    <span class="comment">/* Enable HFCLK2  */</span></div><div class="line">    (void)<a class="code" href="group__group__sysclk__clk__hf__funcs.html#gaf3041fc8333478cc7c8d869d2a535d71">Cy_SysClk_ClkHfEnable</a>(HFCLK2);</div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga47252e1861afb4664f43c2e0a5e38055"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga47252e1861afb4664f43c2e0a5e38055">&#9670;&nbsp;</a></span>Cy_SysClk_ClkHfIsEnabled()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Cy_SysClk_ClkHfIsEnabled </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>clkHf</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reports the Enabled/Disabled status of clkHf. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">clkHf</td><td>Selects which clkHf to check.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Boolean status of clkHf: true - Enabled, false - Disabled.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: HFCLK1 is no longer required in the application and can be</span></div><div class="line"><span class="comment">                 switched off.</span></div><div class="line"><span class="comment">       Note:     HFCLK0 cannot be disabled */</span></div><div class="line"></div><div class="line"><span class="preprocessor">    #define HFCLK1 (1UL)</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span> (<a class="code" href="group__group__sysclk__clk__hf__funcs.html#ga47252e1861afb4664f43c2e0a5e38055">Cy_SysClk_ClkHfIsEnabled</a>(HFCLK1))</div><div class="line">    {</div><div class="line">        <span class="comment">/* Disable HFCLK1 */</span></div><div class="line">        (void)<a class="code" href="group__group__sysclk__clk__hf__funcs.html#gaaa60ae6f69c8a594756a219ac8891358">Cy_SysClk_ClkHfDisable</a>(HFCLK1);</div><div class="line">    }</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A devices. </dd></dl>

</div>
</div>
<a id="gaaa60ae6f69c8a594756a219ac8891358"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaa60ae6f69c8a594756a219ac8891358">&#9670;&nbsp;</a></span>Cy_SysClk_ClkHfDisable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a> Cy_SysClk_ClkHfDisable </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>clkHf</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Disables the selected clkHf. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">clkHf</td><td>Selects which clkHf to enable.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a></dd></dl>
<dl class="section note"><dt>Note</dt><dd>clkHf[0] cannot be disabled.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: HFCLK1 is no longer required in the application and can be</span></div><div class="line"><span class="comment">                 switched off.</span></div><div class="line"><span class="comment">       Note:     HFCLK0 cannot be disabled */</span></div><div class="line"></div><div class="line"><span class="preprocessor">    #define HFCLK1 (1UL)</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span> (<a class="code" href="group__group__sysclk__clk__hf__funcs.html#ga47252e1861afb4664f43c2e0a5e38055">Cy_SysClk_ClkHfIsEnabled</a>(HFCLK1))</div><div class="line">    {</div><div class="line">        <span class="comment">/* Disable HFCLK1 */</span></div><div class="line">        (void)<a class="code" href="group__group__sysclk__clk__hf__funcs.html#gaaa60ae6f69c8a594756a219ac8891358">Cy_SysClk_ClkHfDisable</a>(HFCLK1);</div><div class="line">    }</div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga2d39c7e5111f9ba0738f032a98b4593e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2d39c7e5111f9ba0738f032a98b4593e">&#9670;&nbsp;</a></span>Cy_SysClk_ClkHfSetSource()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a> Cy_SysClk_ClkHfSetSource </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>clkHf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__sysclk__clk__hf__enums.html#gabac2d6b9124a00860dcd781a922788d6">cy_en_clkhf_in_sources_t</a>&#160;</td>
          <td class="paramname"><em>source</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Selects the source of the selected clkHf. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">clkHf</td><td>selects which clkHf mux to configure.</td></tr>
    <tr><td class="paramname">source</td><td><a class="el" href="group__group__sysclk__clk__hf__enums.html#gabac2d6b9124a00860dcd781a922788d6">cy_en_clkhf_in_sources_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a> CY_PRA_STATUS_* - For the PSoC 64 devices there are possible situations when function returns the PRA error status code <a class="el" href="group__group__pra__enums.html#ga60be13e12e82986f8c0d6c6a6d4f12c5">cy_en_pra_status_t</a> instead of <a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a>. This is because for PSoC 64 devices the function uses the PRA driver to change the protected registers. Refer to <a class="el" href="group__group__pra__enums.html#ga60be13e12e82986f8c0d6c6a6d4f12c5">cy_en_pra_status_t</a> for more details.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Call <a class="el" href="group__group__startup__config__system__functions.html#gae0c36a9591fe6e9c45ecb21a794f0f0f">SystemCoreClockUpdate</a> after this function calling if it affects the CLK_HF0 frequency.</dd>
<dd>
Call <a class="el" href="group__group__syslib__functions.html#ga8b897f8554957f9393f645d5ab1106c9">Cy_SysLib_SetWaitStates</a> before calling this function if CLK_HF0 frequency is increasing.</dd>
<dd>
Call <a class="el" href="group__group__syslib__functions.html#ga8b897f8554957f9393f645d5ab1106c9">Cy_SysLib_SetWaitStates</a> after calling this function if CLK_HF0 frequency is decreasing.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: HFCLK1 source may have been updated to Path 0 somewhere in the</span></div><div class="line"><span class="comment">                 application. Check if it was and change the source to Path 1. */</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span>(<a class="code" href="group__group__sysclk__clk__hf__enums.html#ggabac2d6b9124a00860dcd781a922788d6ab67e691f04cd3aecb2a4cbf8bbd5b787">CY_SYSCLK_CLKHF_IN_CLKPATH0</a> == <a class="code" href="group__group__sysclk__clk__hf__funcs.html#ga464acde9f381963929fae73189e80f5c">Cy_SysClk_ClkHfGetSource</a>(1UL))</div><div class="line">    {</div><div class="line">        <span class="comment">/* Set the HFCLK1 source to Path 1 clock */</span></div><div class="line">        (void)<a class="code" href="group__group__sysclk__clk__hf__funcs.html#gaaa60ae6f69c8a594756a219ac8891358">Cy_SysClk_ClkHfDisable</a>(1UL);</div><div class="line">        (void)<a class="code" href="group__group__sysclk__clk__hf__funcs.html#ga2d39c7e5111f9ba0738f032a98b4593e">Cy_SysClk_ClkHfSetSource</a>(1UL, <a class="code" href="group__group__sysclk__clk__hf__enums.html#ggabac2d6b9124a00860dcd781a922788d6a69197ee41c916c6e61d81dbe9be1825f">CY_SYSCLK_CLKHF_IN_CLKPATH1</a>);</div><div class="line">        (void)<a class="code" href="group__group__sysclk__clk__hf__funcs.html#gaf3041fc8333478cc7c8d869d2a535d71">Cy_SysClk_ClkHfEnable</a>(1UL);</div><div class="line">    }</div></div><!-- fragment --> </dd></dl>
<dl class="section note"><dt>Note</dt><dd>Take into account the possible platform specific clkHf (and further clocking chain links) frequency limitations while using this API.</dd>
<dd>
It takes four cycles of the originally selected clock to switch away from it. Do not disable the original clock during this time. </dd></dl>

</div>
</div>
<a id="ga464acde9f381963929fae73189e80f5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga464acde9f381963929fae73189e80f5c">&#9670;&nbsp;</a></span>Cy_SysClk_ClkHfGetSource()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__sysclk__clk__hf__enums.html#gabac2d6b9124a00860dcd781a922788d6">cy_en_clkhf_in_sources_t</a> Cy_SysClk_ClkHfGetSource </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>clkHf</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reports the source of the selected clkHf. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">clkHf</td><td>selects which clkHf to get the source of.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__group__sysclk__clk__hf__enums.html#gabac2d6b9124a00860dcd781a922788d6">cy_en_clkhf_in_sources_t</a></dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: HFCLK1 source may have been updated to Path 0 somewhere in the</span></div><div class="line"><span class="comment">                 application. Check if it was and change the source to Path 1. */</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span>(<a class="code" href="group__group__sysclk__clk__hf__enums.html#ggabac2d6b9124a00860dcd781a922788d6ab67e691f04cd3aecb2a4cbf8bbd5b787">CY_SYSCLK_CLKHF_IN_CLKPATH0</a> == <a class="code" href="group__group__sysclk__clk__hf__funcs.html#ga464acde9f381963929fae73189e80f5c">Cy_SysClk_ClkHfGetSource</a>(1UL))</div><div class="line">    {</div><div class="line">        <span class="comment">/* Set the HFCLK1 source to Path 1 clock */</span></div><div class="line">        (void)<a class="code" href="group__group__sysclk__clk__hf__funcs.html#gaaa60ae6f69c8a594756a219ac8891358">Cy_SysClk_ClkHfDisable</a>(1UL);</div><div class="line">        (void)<a class="code" href="group__group__sysclk__clk__hf__funcs.html#ga2d39c7e5111f9ba0738f032a98b4593e">Cy_SysClk_ClkHfSetSource</a>(1UL, <a class="code" href="group__group__sysclk__clk__hf__enums.html#ggabac2d6b9124a00860dcd781a922788d6a69197ee41c916c6e61d81dbe9be1825f">CY_SYSCLK_CLKHF_IN_CLKPATH1</a>);</div><div class="line">        (void)<a class="code" href="group__group__sysclk__clk__hf__funcs.html#gaf3041fc8333478cc7c8d869d2a535d71">Cy_SysClk_ClkHfEnable</a>(1UL);</div><div class="line">    }</div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga66c6e94768403ab318f2aa321b4c1e50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga66c6e94768403ab318f2aa321b4c1e50">&#9670;&nbsp;</a></span>Cy_SysClk_ClkHfSetDivider()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a> Cy_SysClk_ClkHfSetDivider </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>clkHf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__sysclk__clk__hf__enums.html#gadfbf0caf87af7cd757648124fb17d1d4">cy_en_clkhf_dividers_t</a>&#160;</td>
          <td class="paramname"><em>divider</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the pre-divider for a clkHf. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">clkHf</td><td>selects which clkHf divider to configure.</td></tr>
    <tr><td class="paramname">divider</td><td><a class="el" href="group__group__sysclk__clk__hf__enums.html#gadfbf0caf87af7cd757648124fb17d1d4">cy_en_clkhf_dividers_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a> CY_PRA_STATUS_* - For the PSoC 64 devices there are possible situations when function returns the PRA error status code <a class="el" href="group__group__pra__enums.html#ga60be13e12e82986f8c0d6c6a6d4f12c5">cy_en_pra_status_t</a> instead of <a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a>. This is because for PSoC 64 devices the function uses the PRA driver to change the protected registers. Refer to <a class="el" href="group__group__pra__enums.html#ga60be13e12e82986f8c0d6c6a6d4f12c5">cy_en_pra_status_t</a> for more details.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Also call <a class="el" href="group__group__sysclk__clk__hf__funcs.html#ga2d39c7e5111f9ba0738f032a98b4593e">Cy_SysClk_ClkHfSetSource</a> to set the clkHf source.</dd>
<dd>
Call <a class="el" href="group__group__startup__config__system__functions.html#gae0c36a9591fe6e9c45ecb21a794f0f0f">SystemCoreClockUpdate</a> after this function calling if it affects the CLK_HF0 frequency.</dd>
<dd>
Call <a class="el" href="group__group__syslib__functions.html#ga8b897f8554957f9393f645d5ab1106c9">Cy_SysLib_SetWaitStates</a> before calling this function if CLK_HF0 frequency is increasing.</dd>
<dd>
Call <a class="el" href="group__group__syslib__functions.html#ga8b897f8554957f9393f645d5ab1106c9">Cy_SysLib_SetWaitStates</a> after calling this function if CLK_HF0 frequency is decreasing.</dd>
<dd>
Take into account the possible platform specific clkHf (and further clocking chain links) frequency limitations while using this API.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: Set HFCLK0 divider to 8, to reduce frequency and save power */</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span>(<a class="code" href="group__group__sysclk__clk__hf__enums.html#ggadfbf0caf87af7cd757648124fb17d1d4ab24eafa784b1cc50c94072e6be0dd4b8">CY_SYSCLK_CLKHF_DIVIDE_BY_8</a> != <a class="code" href="group__group__sysclk__clk__hf__funcs.html#ga4d8e4a7091e32319bc2c79f3e2809912">Cy_SysClk_ClkHfGetDivider</a>(0UL))</div><div class="line">    {</div><div class="line">        <span class="comment">/* Set the HFCLK0 divider to 8 */</span></div><div class="line">        (void)<a class="code" href="group__group__sysclk__clk__hf__funcs.html#ga66c6e94768403ab318f2aa321b4c1e50">Cy_SysClk_ClkHfSetDivider</a>(0UL, <a class="code" href="group__group__sysclk__clk__hf__enums.html#ggadfbf0caf87af7cd757648124fb17d1d4ab24eafa784b1cc50c94072e6be0dd4b8">CY_SYSCLK_CLKHF_DIVIDE_BY_8</a>);</div><div class="line">    }</div><div class="line"></div><div class="line">    <span class="comment">/* Check the HFCLK0 frequency */</span></div><div class="line">    uint32_t clkHf0freq = <a class="code" href="group__group__sysclk__clk__hf__funcs.html#gafa8c21271b8cb1b1fd9f7fb489a8d2b3">Cy_SysClk_ClkHfGetFrequency</a>(0UL);</div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga4d8e4a7091e32319bc2c79f3e2809912"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4d8e4a7091e32319bc2c79f3e2809912">&#9670;&nbsp;</a></span>Cy_SysClk_ClkHfGetDivider()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__sysclk__clk__hf__enums.html#gadfbf0caf87af7cd757648124fb17d1d4">cy_en_clkhf_dividers_t</a> Cy_SysClk_ClkHfGetDivider </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>clkHf</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reports the pre-divider value for a clkHf. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">clkHf</td><td>selects which clkHf to check divider of.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__group__sysclk__clk__hf__enums.html#gadfbf0caf87af7cd757648124fb17d1d4">cy_en_clkhf_dividers_t</a></dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: Set HFCLK0 divider to 8, to reduce frequency and save power */</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span>(<a class="code" href="group__group__sysclk__clk__hf__enums.html#ggadfbf0caf87af7cd757648124fb17d1d4ab24eafa784b1cc50c94072e6be0dd4b8">CY_SYSCLK_CLKHF_DIVIDE_BY_8</a> != <a class="code" href="group__group__sysclk__clk__hf__funcs.html#ga4d8e4a7091e32319bc2c79f3e2809912">Cy_SysClk_ClkHfGetDivider</a>(0UL))</div><div class="line">    {</div><div class="line">        <span class="comment">/* Set the HFCLK0 divider to 8 */</span></div><div class="line">        (void)<a class="code" href="group__group__sysclk__clk__hf__funcs.html#ga66c6e94768403ab318f2aa321b4c1e50">Cy_SysClk_ClkHfSetDivider</a>(0UL, <a class="code" href="group__group__sysclk__clk__hf__enums.html#ggadfbf0caf87af7cd757648124fb17d1d4ab24eafa784b1cc50c94072e6be0dd4b8">CY_SYSCLK_CLKHF_DIVIDE_BY_8</a>);</div><div class="line">    }</div><div class="line"></div><div class="line">    <span class="comment">/* Check the HFCLK0 frequency */</span></div><div class="line">    uint32_t clkHf0freq = <a class="code" href="group__group__sysclk__clk__hf__funcs.html#gafa8c21271b8cb1b1fd9f7fb489a8d2b3">Cy_SysClk_ClkHfGetFrequency</a>(0UL);</div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="gafa8c21271b8cb1b1fd9f7fb489a8d2b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafa8c21271b8cb1b1fd9f7fb489a8d2b3">&#9670;&nbsp;</a></span>Cy_SysClk_ClkHfGetFrequency()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t Cy_SysClk_ClkHfGetFrequency </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>clkHf</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Reports the frequency of the selected clkHf. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">clkHf</td><td>Selects the clkHf</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The frequency, in Hz.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The reported frequency may be zero, which indicates unknown. This happens if the source input is dsi_out or clk_altlf.</dd>
<dd>
Calculates the HF frequency irrespective of whether HF is enabled or not.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: Set HFCLK0 divider to 8, to reduce frequency and save power */</span></div><div class="line"></div><div class="line">    <span class="keywordflow">if</span>(<a class="code" href="group__group__sysclk__clk__hf__enums.html#ggadfbf0caf87af7cd757648124fb17d1d4ab24eafa784b1cc50c94072e6be0dd4b8">CY_SYSCLK_CLKHF_DIVIDE_BY_8</a> != <a class="code" href="group__group__sysclk__clk__hf__funcs.html#ga4d8e4a7091e32319bc2c79f3e2809912">Cy_SysClk_ClkHfGetDivider</a>(0UL))</div><div class="line">    {</div><div class="line">        <span class="comment">/* Set the HFCLK0 divider to 8 */</span></div><div class="line">        (void)<a class="code" href="group__group__sysclk__clk__hf__funcs.html#ga66c6e94768403ab318f2aa321b4c1e50">Cy_SysClk_ClkHfSetDivider</a>(0UL, <a class="code" href="group__group__sysclk__clk__hf__enums.html#ggadfbf0caf87af7cd757648124fb17d1d4ab24eafa784b1cc50c94072e6be0dd4b8">CY_SYSCLK_CLKHF_DIVIDE_BY_8</a>);</div><div class="line">    }</div><div class="line"></div><div class="line">    <span class="comment">/* Check the HFCLK0 frequency */</span></div><div class="line">    uint32_t clkHf0freq = <a class="code" href="group__group__sysclk__clk__hf__funcs.html#gafa8c21271b8cb1b1fd9f7fb489a8d2b3">Cy_SysClk_ClkHfGetFrequency</a>(0UL);</div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="gace8a5255f8579c17f4062dccb3ff3694"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gace8a5255f8579c17f4062dccb3ff3694">&#9670;&nbsp;</a></span>Cy_SysClk_ClkHfDirectSel()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a> Cy_SysClk_ClkHfDirectSel </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>clkHf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>enable</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enable/Disable the direct source selection as IMO for CLK_HF[[n]]. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">clkHf</td><td>Selects the clkHf</td></tr>
    <tr><td class="paramname">enable</td><td>True - Selects IMO for CAT1B/CAT1C or IHO for CAT1D, False - Selects Root Mux</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__group__sysclk__returns.html#gad6699a184e2e3c01433251b0981558f3">cy_en_sysclk_status_t</a> CY_SYSCLK_BAD_PARAM - If clkhf is incorrect. CY_SYSCLK_SUCCESS - If successfully Enabled/Disabled.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (TVIIBE only), CAT1B, CAT1C and CAT1D devices. </dd></dl>

</div>
</div>
<a id="ga58bb033cfac5881d026e32643ed6c6b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga58bb033cfac5881d026e32643ed6c6b7">&#9670;&nbsp;</a></span>Cy_SysClk_IsClkHfDirectSelEnabled()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Cy_SysClk_IsClkHfDirectSelEnabled </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>clkHf</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Checks if direct source selection as IMO for CLK_HF[[n]] is enabled/disabled. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">clkHf</td><td>Selects the clkHf</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True - IMO selected for CAT1A/CAT1B/CAT1C or IHO for CAT1D, False - Root Mux is selected.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (TVIIBE only), CAT1B, CAT1C and CAT1D devices. </dd></dl>

</div>
</div>
<a id="ga46accf22663e93afbcd92d41fe47f613"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga46accf22663e93afbcd92d41fe47f613">&#9670;&nbsp;</a></span>Cy_SysClk_ClkHfGetMaskOnPath()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t Cy_SysClk_ClkHfGetMaskOnPath </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__sysclk__clk__hf__enums.html#gabac2d6b9124a00860dcd781a922788d6">cy_en_clkhf_in_sources_t</a>&#160;</td>
          <td class="paramname"><em>clkPath</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get Mask value for the HF Clocks selected and enabled for clkPath as source e.g. </p>
<p>Mask return will have Bit 0 set if HFCLK0 is enabled and source is clkPath</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">clkPath</td><td>clock path</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>mask of CLKHF for which clock path is set</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available CAT1D for LP PLL </dd></dl>

</div>
</div>
<a id="gad7f4310594a4441d01ac1c46df0a1234"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad7f4310594a4441d01ac1c46df0a1234">&#9670;&nbsp;</a></span>Cy_SysClk_ClkHfAllGetMask()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t Cy_SysClk_ClkHfAllGetMask </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get Mask value for the all HF Clocks e.g. </p>
<p>Mask return will have Bit 0 set if HFCLK0 is enabled</p>
<dl class="section return"><dt>Returns</dt><dd>mask of CLKHF</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available only for CAT1D devices </dd></dl>

</div>
</div>
<a id="ga3b86beecfee7ea5361decab70bc7e4b3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3b86beecfee7ea5361decab70bc7e4b3">&#9670;&nbsp;</a></span>Cy_SysClk_ClkHfEnableDividerWithMask()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysClk_ClkHfEnableDividerWithMask </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>clkHfMask</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__group__sysclk__clk__hf__enums.html#gadfbf0caf87af7cd757648124fb17d1d4">cy_en_clkhf_dividers_t</a>&#160;</td>
          <td class="paramname"><em>divider</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Divide all the enabled CLK_HF's with the divider value. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">clkHfMask</td><td>CLKHF mask for of the Clocks</td></tr>
    <tr><td class="paramname">divider</td><td>Divider Value <a class="el" href="group__group__sysclk__clk__hf__enums.html#gadfbf0caf87af7cd757648124fb17d1d4">cy_en_clkhf_dividers_t</a></td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1D devices </dd></dl>

</div>
</div>
<a id="ga4053d66942358380e99583c0ef4d99a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4053d66942358380e99583c0ef4d99a5">&#9670;&nbsp;</a></span>Cy_SysClk_ClkHfEnableDirectMuxWithMask()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysClk_ClkHfEnableDirectMuxWithMask </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>clkHfMask</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>enable</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Enable/ Disable the clock path for the HF Clocks in clkHfMask in disable case ROOT path will be enabled in enable case ROOT path will be disabled. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">clkHfMask</td><td>CLKHF mask for of the Clocks</td></tr>
    <tr><td class="paramname">enable</td><td>to enable or disable direct path</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available CAT1D for LP PLL, CDT_005549-196 </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
